Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[D1] Cleaning up Build with D1 #18321

Merged
merged 26 commits into from
Dec 11, 2024
Merged

[D1] Cleaning up Build with D1 #18321

merged 26 commits into from
Dec 11, 2024

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Nov 21, 2024

Summary

  1. Moved "Error" and "Error list" section out of "Query D1", and into Observability/Debug D1/.
  2. Added a public/redirect for "Query D1" into "Workers Binding API".
  3. Replaced all links pointing to Query D1 to the new API chapters, being as specific as possible.
  4. Created a new subfolder for "REST API", which includes both REST API and Wrangler commands.
  5. Made Wrangler commands for D1 into its own partial file, and rendered it directly into D1 (as well as the Wrangler doc).

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Copy link

cloudflare-workers-and-pages bot commented Nov 21, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 66776f5
Status: ✅  Deploy successful!
Preview URL: https://d92750b7.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev

View logs

Copy link
Contributor

github-actions bot commented Nov 21, 2024

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/d1/build-with-d1/d1-client-api/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/build-with-d1/d1-client-api/
https://developers.cloudflare.com/workers/wrangler/commands/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/workers/wrangler/commands/
https://developers.cloudflare.com/d1/best-practices/query-d1/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/best-practices/query-d1/
https://developers.cloudflare.com/d1/observability/debug-d1/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/observability/debug-d1/
https://developers.cloudflare.com/d1/worker-api/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/worker-api/
https://developers.cloudflare.com/d1/best-practices/import-export-data/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/best-practices/import-export-data/
https://developers.cloudflare.com/d1/wrangler-commands/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/wrangler-commands/
https://developers.cloudflare.com/d1/tutorials/build-an-api-to-access-d1/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/tutorials/build-an-api-to-access-d1/
https://developers.cloudflare.com/d1/get-started/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/get-started/
https://developers.cloudflare.com/d1/reference/wrangler-commands/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/reference/wrangler-commands/
https://developers.cloudflare.com/d1/sql-api/query-json/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/sql-api/query-json/
https://developers.cloudflare.com/d1/observability/metrics-analytics/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/observability/metrics-analytics/
https://developers.cloudflare.com/d1/reference/generated-columns/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/reference/generated-columns/
https://developers.cloudflare.com/d1/sql-api/foreign-keys/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/sql-api/foreign-keys/
https://developers.cloudflare.com/d1/worker-api/prepared-statements/ https://jun-d1-api-cleanup.cloudflare-docs-7ou.pages.dev/d1/worker-api/prepared-statements/

Copy link
Contributor

github-actions bot commented Nov 22, 2024

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /d1/build-with-d1/import-export-data/
  • /d1/build-with-d1/
  • /d1/build-with-d1/local-development/
  • /d1/build-with-d1/remote-development/
  • /d1/build-with-d1/use-d1-from-pages/
  • /d1/build-with-d1/use-indexes/
  • /d1/build-with-d1/d1-client-api/
  • /d1/reference/wrangler-commands/
  • /d1/build-with-d1/foreign-keys/

public/_redirects Outdated Show resolved Hide resolved
Copy link
Contributor

@vy-ton vy-ton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

  • Can we put Remote development under local development
  • I want to rename Build with D1 to Best practices

src/content/docs/d1/build-with-d1/query-d1.mdx Outdated Show resolved Hide resolved
src/content/docs/d1/rest-api/index.mdx Outdated Show resolved Hide resolved
src/content/docs/d1/build-with-d1/query-d1.mdx Outdated Show resolved Hide resolved
src/content/docs/d1/build-with-d1/query-d1.mdx Outdated Show resolved Hide resolved
src/content/docs/d1/build-with-d1/query-d1.mdx Outdated Show resolved Hide resolved
@Oxyjun Oxyjun requested a review from a team as a code owner December 5, 2024 17:56
Copy link
Contributor

@vy-ton vy-ton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

  • For Rest and Wrangler we should remove the D1 in the section title

src/content/docs/d1/best-practices/query-d1.mdx Outdated Show resolved Hide resolved
src/content/docs/d1/best-practices/query-d1.mdx Outdated Show resolved Hide resolved
@Oxyjun Oxyjun enabled auto-merge (squash) December 10, 2024 13:59
@Oxyjun Oxyjun merged commit 57bd74f into production Dec 11, 2024
12 checks passed
@Oxyjun Oxyjun deleted the jun/d1/api-cleanup branch December 11, 2024 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:d1 D1: https://developers.cloudflare.com/d1/ product:pages product:workers Related to Workers product size/xl
Projects
None yet
Development

Successfully merging this pull request may close these issues.